IviRFSigGen Get LF Generator Name [LF]

IviRFSigGenLFGenerator Capability Group

This VI returns the specific driver defined LF generator source name that corresponds to the one-based index specified by the Index parameter. If you pass in a value for the Index parameter that is less than one or greater than the value of the IviRFSigGen>>LF Generator>>LF Generator Count property, the VI returns an empty string in the Name parameter and returns the Invalid Value error.

Note: For an instrument with only one LF generator source, i.e. the IviRFSigGen>>LF Generator>>LF Generator Count property is one, the driver may return an empty string.

instrument handle The instrument handle that you obtain from the IviRFSigGen Initialize or IviRFSigGen Initialize With Options VIs.
index The index of the analog modulation source whose name is returned. The value must be greater than or equal to one and less than or equal to IviRFSigGen>>LF Generator>>LF Generator Count.

Note:

Zero is not a legal value.

Default Value: 0
name buffer size Specify the buffer size for the Name parameter.

Default Value: 0
error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

instrument handle out The instrument handle that you obtain from the IviRFSigGen Initialize or IviRFSigGen Initialize With Options VIs.
name The LF generator source name that corresponds to the Index.

The Name buffer must contain at least as many elements as the value you specify with the Name Buffer Size parameter.

Default Value: ""
error out The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.